<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>killerbee.KillerBee</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="killerbee-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/killerbee/">KillerBee</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="killerbee-module.html">Package&nbsp;killerbee</a> ::
        Class&nbsp;KillerBee
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="killerbee.KillerBee-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class KillerBee</h1><p class="nomargin-top"><span class="codelink"><a href="killerbee-pysrc.html#KillerBee">source&nbsp;code</a></span></p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">device</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">datasource</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">gps</span>=<span class="summary-sig-default">None</span>)</span><br />
      Instantiates the KillerBee class.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Boolean</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#__device_is" class="summary-sig-name" onclick="show_private();">__device_is</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">vendorId</span>,
        <span class="summary-sig-arg">productId</span>)</span><br />
      Compares KillerBee class' device data to a known USB vendorId and 
      productId</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.__device_is">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__search_usb"></a><span class="summary-sig-name">__search_usb</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">device</span>,
        <span class="summary-sig-arg">vendor</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">product</span>=<span class="summary-sig-default">None</span>)</span><br />
      Deprecated in class, use kbutils.search_usb(device, vendor, product) 
      instead of class version.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.__search_usb">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__search_usb_bus"></a><span class="summary-sig-name">__search_usb_bus</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bus</span>,
        <span class="summary-sig-arg">device</span>,
        <span class="summary-sig-arg">vendor</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">product</span>=<span class="summary-sig-default">None</span>)</span><br />
      Deprecated in class, use kbutils.search_usb_bus(bus, device, vendor, 
      product) instead of class version.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.__search_usb_bus">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="dev_list"></a><span class="summary-sig-name">dev_list</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">vendor</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">product</span>=<span class="summary-sig-default">None</span>)</span><br />
      Deprecated in class, use kbutils.devlist() instead.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.dev_list">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">List</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#get_dev_info" class="summary-sig-name">get_dev_info</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns device information in a list identifying the device.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.get_dev_info">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Closes the device out.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.close">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Boolean</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#check_capability" class="summary-sig-name">check_capability</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">capab</span>)</span><br />
      Uses the specified capability to determine if the opened device is 
      supported.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.check_capability">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">List</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#get_capabilities" class="summary-sig-name">get_capabilities</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns a list of capability information for the device.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.get_capabilities">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#sniffer_on" class="summary-sig-name">sniffer_on</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>=<span class="summary-sig-default">None</span>)</span><br />
      Turns the sniffer on such that pnext() will start returning observed 
      data.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.sniffer_on">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#sniffer_off" class="summary-sig-name">sniffer_off</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Turns the sniffer off, freeing the hardware for other functions.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.sniffer_off">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#set_channel" class="summary-sig-name">set_channel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>)</span><br />
      Sets the radio interface to the specifid channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.set_channel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Boolean</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="is_valid_channel"></a><span class="summary-sig-name">is_valid_channel</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>)</span><br />
      Based on sniffer capabilities, return if this is an OK channel 
      number.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.is_valid_channel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#inject" class="summary-sig-name">inject</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">packet</span>,
        <span class="summary-sig-arg">channel</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">count</span>=<span class="summary-sig-default">1</span>,
        <span class="summary-sig-arg">delay</span>=<span class="summary-sig-default">0</span>)</span><br />
      Injects the specified packet contents.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.inject">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">List</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#pnext" class="summary-sig-name">pnext</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">100</span>)</span><br />
      Returns packet data as a string, else None.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.pnext">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">None</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee.KillerBee-class.html#jammer_on" class="summary-sig-name">jammer_on</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>=<span class="summary-sig-default">None</span>)</span><br />
      Attempts reflexive jamming on all 802.15.4 frames.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#KillerBee.jammer_on">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="killerbee.KillerBee-class.html#channel" class="summary-name">channel</a><br />
      Getter function for the channel that was last set on the device.
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">device</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">datasource</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">gps</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Instantiates the KillerBee class.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>device</code></strong> (String) - Device identifier, either USB vendor:product, serial device node,
          or IP address</li>
        <li><strong class="pname"><code>datasource</code></strong> (String) - A known datasource type that is used by dblog to record how the 
          data was captured.</li>
        <li><strong class="pname"><code>gps</code></strong> (String) - Optional serial device identifier for an attached GPS unit. If 
          provided, or if global variable has previously been set, 
          KillerBee skips that device in initalization process.</li>
    </ul></dd>
    <dt>Returns: None</dt>
        <dd>None</dd>
  </dl>
</td></tr></table>
</div>
<a name="__device_is"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__device_is</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">vendorId</span>,
        <span class="sig-arg">productId</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.__device_is">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Compares KillerBee class' device data to a known USB vendorId and 
  productId</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>vendorId</code></strong> ()</li>
        <li><strong class="pname"><code>productId</code></strong> ()</li>
    </ul></dd>
    <dt>Returns: Boolean</dt>
        <dd>True if KillerBee class has device matching the vendor and 
          product IDs provided.</dd>
  </dl>
</td></tr></table>
</div>
<a name="get_dev_info"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_dev_info</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.get_dev_info">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns device information in a list identifying the device. 
  Implemented by the loaded driver.</p>
  <dl class="fields">
    <dt>Returns: List</dt>
        <dd>List of 3 strings identifying device.</dd>
  </dl>
</td></tr></table>
</div>
<a name="close"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.close">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Closes the device out.</p>
  <dl class="fields">
    <dt>Returns: None</dt>
        <dd>None</dd>
  </dl>
</td></tr></table>
</div>
<a name="check_capability"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">check_capability</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">capab</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.check_capability">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Uses the specified capability to determine if the opened device is 
  supported.  Returns True when supported, else False.</p>
  <dl class="fields">
    <dt>Returns: Boolean</dt>
  </dl>
</td></tr></table>
</div>
<a name="get_capabilities"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_capabilities</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.get_capabilities">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a list of capability information for the device.</p>
  <dl class="fields">
    <dt>Returns: List</dt>
        <dd>Capability information for the opened device.</dd>
  </dl>
</td></tr></table>
</div>
<a name="sniffer_on"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sniffer_on</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.sniffer_on">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Turns the sniffer on such that pnext() will start returning observed 
  data.  Will set the command mode to Air Capture if it is not already 
  set.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> (Integer) - Sets the channel, optional</li>
    </ul></dd>
    <dt>Returns: None</dt>
  </dl>
</td></tr></table>
</div>
<a name="sniffer_off"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sniffer_off</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.sniffer_off">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Turns the sniffer off, freeing the hardware for other functions.  It 
  is not necessary to call this function before closing the interface with 
  close().</p>
  <dl class="fields">
    <dt>Returns: None</dt>
  </dl>
</td></tr></table>
</div>
<a name="set_channel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_channel</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.set_channel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the radio interface to the specifid channel. Currently, support 
  is limited to 2.4 GHz channels 11 - 26.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> (Integer) - Sets the channel, optional</li>
    </ul></dd>
    <dt>Returns: None</dt>
  </dl>
</td></tr></table>
</div>
<a name="inject"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">inject</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">packet</span>,
        <span class="sig-arg">channel</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">count</span>=<span class="sig-default">1</span>,
        <span class="sig-arg">delay</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.inject">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Injects the specified packet contents.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>packet</code></strong> (String) - Packet contents to transmit, without FCS.</li>
        <li><strong class="pname"><code>channel</code></strong> (Integer) - Sets the channel, optional</li>
        <li><strong class="pname"><code>count</code></strong> (Integer) - Transmits a specified number of frames, def=1</li>
        <li><strong class="pname"><code>delay</code></strong> (Float) - Delay between each frame, def=1</li>
    </ul></dd>
    <dt>Returns: None</dt>
  </dl>
</td></tr></table>
</div>
<a name="pnext"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">pnext</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">timeout</span>=<span class="sig-default">100</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.pnext">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns packet data as a string, else None.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>timeout</code></strong> (Integer) - Timeout to wait for packet reception in usec</li>
    </ul></dd>
    <dt>Returns: List</dt>
        <dd>Returns None is timeout expires and no packet received.  When a 
          packet is received, a list is returned, in the form [ String: 
          packet contents | Bool: Valid CRC | Int: Unscaled RSSI ]</dd>
  </dl>
</td></tr></table>
</div>
<a name="jammer_on"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">jammer_on</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#KillerBee.jammer_on">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Attempts reflexive jamming on all 802.15.4 frames. Targeted frames 
  must be &gt;12 bytes for reliable jamming in current firmware.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> (Integer) - Sets the channel, optional.</li>
    </ul></dd>
    <dt>Returns: None</dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="channel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">channel</h3>
  <p>Getter function for the channel that was last set on the device.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.channel(<span class="summary-sig-arg">self</span>)</span>
        - Getter function for the channel that was last set on the device.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="killerbee-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/killerbee/">KillerBee</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Dec 30 17:49:12 2013
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
